Skip to content

[ui] Add additional node information in the documentation tab #2802

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Sep 9, 2025
Merged

[ui] Add additional node information in the documentation tab #2802

merged 6 commits into from
Sep 9, 2025

Conversation

@Alxiice
Copy link
Contributor

@Alxiice Alxiice commented Aug 13, 2025 •
edited
Loading

Description

This PR adds additional information on the Documentation tab of nodes.
Here are examples :

import os
from meshroom.core import desc

__version__ = "1.0"
__author__ = "moduleauthor"
__license__ = "MIT"

class TestCLNode(desc.CommandLineNode):
    category = 'TestPlugin'
    commandLine = 'command'
    
    documentation = """# TestCLNode
## Node info
here are info on the node

## How to use it
Here are more info
1. First step
2. Second step
"""
image

Also we can override parameters at the node level :

  • "author" and "version" can be directly overrided
  • It is possible to put any additional information in a __nodeInfo__ list
class TestCLNode2(desc.CommandLineNode):
    """# TestCLNode

## Node info
here are info on the node

## How to use it
Here are more info
1. First step
2. Second step
"""

    category = 'TestPlugin'
    author = "Alice"
    version = "2.0.0"
    __nodeInfo__ = [
        ("model link", "https://huggingface.co/alicevision/great-model")
    ]
image

Finally I also added the possibility to read the documentation from the class __doc__ parameterr

@codecov
Copy link

codecov bot commented Aug 13, 2025 •
edited
Loading

Codecov Report

❌ Patch coverage is 92.00000% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 77.77%. Comparing base (de33f55) to head (2cb2c1a).
⚠️ Report is 7 commits behind head on develop.

Files with missing lines Patch % Lines
meshroom/core/node.py 76.92% 6 Missing ⚠️
Additional details and impacted files 
@@             Coverage Diff             @@
##           develop    #2802      +/-   ##
===========================================
+ Coverage    77.59%   77.77%   +0.18%     
===========================================
  Files           48       50       +2     
  Lines         6655     6728      +73     
===========================================
+ Hits          5164     5233      +69     
- Misses        1491     1495       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Alxiice Alxiice added this to the Meshroom 2025.x milestone Aug 13, 2025
@fabiencastan
Copy link
Member

fabiencastan commented Aug 17, 2025

I would suggest a simplication like this (with a fallback on the module):

class TestCLNode2(desc.CommandLineNode):
    """# TestCLNode

## Node info
here are info on the node

## How to use it
Here are more info
1. First step
2. Second step
"""

    category = 'TestPlugin'
    commandLine = 'python ' + exe_path
    author = "Alice"
    version = "2.0.0"

@Alxiice Alxiice force-pushed the dev/node_documentation_add_module_infos branch 3 times, most recently from eb98668 to 41765b8 Compare August 21, 2025 09:02
@Alxiice Alxiice force-pushed the dev/node_documentation_add_module_infos branch 2 times, most recently from aa9092b to 12bf616 Compare August 25, 2025 08:50
cbentejac
cbentejac requested changes Aug 27, 2025
View reviewed changes
Copy link
Contributor

@cbentejac cbentejac left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documentation keys should be capitalized in the display but apart from that, everything is working well and ready to be merged!

@Alxiice Alxiice force-pushed the dev/node_documentation_add_module_infos branch from 12bf616 to a3744f9 Compare September 5, 2025 13:49
@Alxiice Alxiice requested a review from cbentejac September 5, 2025 13:50
@cbentejac cbentejac force-pushed the dev/node_documentation_add_module_infos branch from a3744f9 to 2cb2c1a Compare September 9, 2025 08:28
@cbentejac cbentejac merged commit 59b15a7 into develop Sep 9, 2025
5 checks passed
@cbentejac cbentejac deleted the dev/node_documentation_add_module_infos branch September 9, 2025 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cbentejac cbentejac cbentejac approved these changes

@fabiencastan fabiencastan Awaiting requested review from fabiencastan

@demoulinv demoulinv Awaiting requested review from demoulinv

@servantftransperfect servantftransperfect Awaiting requested review from servantftransperfect

@CedricThebault CedricThebault Awaiting requested review from CedricThebault

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

Meshroom 2026.1.0

Development

Successfully merging this pull request may close these issues.

4 participants

@Alxiice @fabiencastan @cbentejac